vcRobotProgramManager

Container for robot programs.

See in: Overview

Module: vcRobotics2

Parent: vcProgramManager

Children -

Referenced by: vcProgramContainer.ProgramManager, vcProgramExecutor.ProgramManager

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
AutoStartProgramvcRobotProgramRWGets or sets a program that is started automatically with the simulation.
TargetContainervcMultiPositionTargetContainerRGets the associated position target container.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
loadProgramFromFiletupleString filePathLoads a program from given file path and adds the prgoram to the manager.
See more
This method enforces uniqueness of the name of the loaded program by renaming when necessary.

Parameters:
filePath (str): Path to program file.

Returns:
tuple[vcProgram, str]: The loaded program and it's original name stored in the file. The name can differ if it wasn't unique and therefore was renamed.

Exceptions:
ValueError: when loading fails.
saveProgramToFileNoneString programName,
String filePath
Save the given program to the given file path. The file will be overwritten, if exists.
See more
Parameters:
programName: (str): Name of an existing program..
filePath (str): Path to program file.

Returns:
None

Exceptions:
ValueError: when saving fails.